Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: REPORT_TITLE and OUTPUT_FILE environment variables #373

Merged
merged 1 commit into from
Sep 19, 2024

Conversation

jmeridth
Copy link
Member

Closes #160

Pull Request

Proposed Changes

  • Adds the ability for users to designate custom report title and output files.
    • Defaults for each:
      • REPORT_TITLE: "Issue Metrics"
      • OUTPUT_FILE: "issue_metrics.md" if markdown and "issue_metrics.json" if json
  • Update .env-example and include changes there and in docs we forgot in feat: add non-mentioning links option #370

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request
  • run make lint and fix any issues that you have introduced
  • run make test and ensure you have test coverage for the lines you are introducing
  • If publishing new data to the public (scorecards, security scan results, code quality results, live dashboards, etc.), please request review from @jeffrey-luszcz

Reviewer

  • Label as either fix, documentation, enhancement, infrastructure, maintenance, or breaking

Closes #160

- [x] Adds the ability for users to designate custom report title and output files.
  - Defaults for each:
    - REPORT_TITLE: "Issue Metrics"
    - OUTPUT_FILE: "issue_metrics.md" if markdown and "issue_metrics.json" if json
- [x] Update `.env-example` and include changes there and in docs we forgot in #370

Signed-off-by: jmeridth <[email protected]>
Co-authored-by: Sebastian Spier <[email protected]>
Co-authored-by: Zack Koppert <[email protected]>
@jmeridth jmeridth force-pushed the jm_custom_report_title_and_output_file branch from 2bb3360 to 82a5a61 Compare September 19, 2024 16:29
Copy link
Member

@zkoppert zkoppert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WOHOO!! Thanks @jmeridth for getting this in! 🎉

@zkoppert zkoppert merged commit 634cf46 into main Sep 19, 2024
31 checks passed
@zkoppert zkoppert deleted the jm_custom_report_title_and_output_file branch September 19, 2024 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants